Fix crash related to useEffect returning a value instead of a function #78708
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matticbot
added
the
[Status] Needs Review
noahtallen
changed the title
|
I'm merging to resolve the page crash asap. |
github-actions
bot
removed
the
[Status] Needs Review
|
This PR does not affect the size of JS and CSS bundles shipped to the user's browser. Generated by performance advisor bot at iscalypsofastyet.com. |
|
I did some searching around, and the types are supposed to handle this situation. However, the types don't forbid callbacks typed as |
TimBroddin
pushed a commit
that referenced
this pull request
Jun 28, 2023
tyxla
reviewed
Jun 28, 2023
|
Wow. Didn't know about this. @noahtallen, thanks for the quick fix! FYI -> @Automattic/caribou |
Yeah, neither did I, to be honest! I'll p2 about it today. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to: #77046
Proposed Changes
Resolves https://a8c.sentry.io/issues/4279026430/?project=6313676
Sentry detected a page crash in this scenario:
After testing this locally, I found warnings in the console about useEffect returning a value. This also lead me to a Stackoverflow post: https://stackoverflow.com/questions/74265321/uncaught-typeerror-destroy-is-not-a-function-error-in-react
The issue is that when useEffect's callback returns a value, React will try to call it as a function. (This function can be used to destroy or unsubscribe from things set up in the effect.)
When that value is not a function, the page crashes.
So I went through several useEffect calls on the related pages and updated several inline effect calls to not return values. We had several which were doing like
useEffect( () => ifCheck && doSomething() ). These can return booleans, which causes the crash. This is probably new behavior in React 18.I fixed this just be wrapping these callbacks in brackets (e.g.
useEffect( () => { ifCheck && doSomething() } )), which should be functionally the same.We will also need to add a linter rule and check this doesn't happen elsewhere.
Testing Instructions
Follow the above bug-reproduction steps and check that there is no crash.